home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 006a / dlfilter.zip / DLFILTER.TXT < prev    next >
Text File  |  1993-04-05  |  10KB  |  249 lines
  1.  
  2.  
  3.  
  4.  
  5.   DOWNLOAD FILTER VERSION 1.0
  6.     
  7.   (C) COPYRIGHT 1993  Jon E. Estes
  8.   All Rights Reserved
  9.  
  10.  
  11.   
  12.   Summary:
  13.     
  14.     Download Filter is designed to allow PCBoard sysops to purge their
  15.     download log file of entries for files which are no longer on board
  16.     or entries older than a given date.  It will run on nearly any size
  17.     BBS system, and has a number of options which allow you to customize
  18.     how you want the program to work.
  19.  
  20.  
  21.  
  22.   
  23.   Shareware:
  24.   
  25.     Download filter is distributed as shareware.  You are free to use
  26.     the program for 30 days for evaluation purposes.  If you wish to
  27.     continue using the program beyond the evaluation period, please
  28.     register the program.  The registration fee for DLFilter is $5 (US).
  29.     To register, please follow the instructions in the file REGISTER.TXT.
  30.  
  31.   Legal Stuff:
  32.   
  33.     Use of this software for any purpose whatsoever constitutes your
  34.     unqualified acceptance of the following statements.
  35.  
  36.       The author makes no warranty or representation that the software
  37.       will be error free.  The author disclaims any warranties, either
  38.     or implied, including but not limited to any implied warranty of
  39.     merchantability or fitness for any particular purpose.
  40.  
  41.     The user agrees to take full responsibility for the selection of and
  42.     any use whatsoever made of the software.
  43.  
  44.     IN NO EVENT WILL THE AUTHOR BE LIABLE FOR ANY DAMAGES WHATSOEVER
  45.     (INCLUDING WITHOUT LIMITATION DAMAGES FOR LOSS OF BUSINESS PROFITS,
  46.     BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION OR THE LIKE)
  47.     ARISING OUT OF THE USE OF, INTERRUPTION IN THE USE OF, OR INABILITY
  48.     TO USE THIS SOFTWARE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF ANY
  49.     POSSIBILITY OR LIKELIHOOD OF SUCH DAMAGES.
  50.  
  51.  
  52.  
  53.  
  54.   
  55.   Basic Information & Requirements:
  56.  
  57.     
  58.       To use Download Filter, the program must be able to find
  59.     PCBOARD.DAT either in the current directory or in the DOS path.  
  60.     The program has been tested under PCBoard 14.5 & 14.5a.  It has not
  61.     yet been tested under version 15.  If you are running version 15, I
  62.     suggest using the "-l" option.  I plan to release an updated version
  63.     soon after version 15 is released.
  64.  
  65.       The program will scan the current download log, purge entries, and
  66.     create a new download log file.  After completion, the program will
  67.     rename the new file with the same name that the prior one had.
  68.     The original download log file will be preserved and renamed with a
  69.     .OLD extension.  By default, PCBoard names this file DOWNLOAD.TXT,
  70.     but this is not required for proper operation of Download Filter.
  71.  
  72.       Download Filter has two basic modes of operation which are
  73.     dependent on the amount of memory available and the number of files
  74.     on your system.  The default mode (quick mode) holds all of the
  75.     required data in memory.  Slow mode does some of the work on disk,
  76.     and as such, will perform more slowly (as the name implies).
  77.       With 550k of RAM free, quick mode should work on a system with up
  78.     to approximately 31,000 files on board.  If you attempt quickmode
  79.     and Download Filter cannot fit your entire file list into memory, it
  80.     will halt and give an error message suggesting the use of the "-s"
  81.     (slow mode) option.
  82.  
  83.       I would suggest running Download Filter after each time you
  84.     perform file maintenance.  With the -o and -n options, it could be
  85.     run in the nightly event to trim out entries more than a certain
  86.     number of days old, though this is probably overkill (weekly would
  87.     be a more probable solution).
  88.  
  89.       To provide a rough gauge of performance, Download filter can
  90.     filter a 600k download log on a BBS containing ~4000 files in about
  91.     3 minutes ('286-12, no cache).  On a '386-33 with a 2Mb cache, the
  92.     comparing the same 600k log against 2500 system files takes about 20
  93.     seconds.  If you run the program with the -n (no scan) option in
  94.     combination with the -o or -p (by days or date) options, processing
  95.     time will be significantly shorter.     Bear in mind that using the -s
  96.     (slow) option may increase times by as much as 15x.
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.   Command Line Options:
  104.     
  105.     NOTE: Case is significant in all command line options.
  106.     
  107.     The simplest option is no options at all:
  108.     
  109.     DLFILTER <enter>
  110.         
  111.         This will scan your system for all files which are located in
  112.         all of the download paths which you have specified in your
  113.         PCBoard setup (including all conferences); therefore every
  114.         downloadable file on your board will be scanned.  Each entry in
  115.         the download log file will be compared against the files on the
  116.         board, and any entries not found will be deleted from the log
  117.         file.
  118.           This option automatically detects and uses .idx files (e.g.  a
  119.         %mainfile.idx in your download path listing) for path
  120.         information, but does a physical search of the paths for file
  121.         information (so your .idx file need not be up to date).
  122.     
  123.     -l filename[.pth]        Use path list file.
  124.        
  125.                              Example: DLFILTER -l PATH.LST
  126.                                       DLFILTER -l makeidx
  127.     
  128.         Instead of scanning your PCBoard download paths, Download
  129.         filter can also make use of a file containing download path
  130.         information.  The format is the same as that used for the
  131.         MAKEIDX program supplied with PCBoard, i.e.  an ASCII text file
  132.         containing a list of pathnames that you want to be scanned.
  133.         Download Filter automatically recurses subdirectories, just as
  134.         MAKEIDX.  
  135.           For example:
  136.           
  137.               C:\PCB\UPLOADS     
  138.               D:\DL01
  139.               E:\
  140.               
  141.           The first and second lines scan the listed directory (and all
  142.         subdirectories).  The third line will scan drive E: in its
  143.         entirety.  Download filter is not sensitive to trailing
  144.         backslashes (i.e. E:\ is treated the same as E:).
  145.         
  146.           The path file name must be listed directly after the -l
  147.         option.  If no extension is provided, .pth is assumed.
  148.  
  149.         NOTE: This option runs somewhat slower than using the PCBoard
  150.               download path information.  The only real reason for
  151.               running this option would be when there are certain
  152.               directories or drives which you want to drop all download
  153.               log entries for (CD-ROM's, for example).
  154.  
  155.  
  156.  
  157.  
  158.               
  159.     -s  Slow Mode option.              
  160.                              
  161.                              Example:  DLFILTER -s
  162.     
  163.           This option tells Download Filter to use the disk to hold the
  164.         bulletin board file information.  This option should only be
  165.         needed in situations where memory is at a premium or when you
  166.         have a very large number of files on the system.
  167.           This option should really only be run if you know you have
  168.         more than 40,000 file on board, or if Download Filter tells you
  169.         that you should try this option.
  170.             The -s option has no effect if the -n option is used (since no 
  171.           file list is generated).
  172.       
  173.         NOTE: This option runs CONSIDERABLY slower than the default.
  174.               Its performance can be helped greatly through the use of
  175.               an XMS or EMS disk cache program.     Even with a cache, be
  176.               prepared to take a nap during this one.
  177.         
  178.         
  179.     -o<dddd>  Purge files Older than <dddd> days.
  180.     
  181.                              Example:  DLFILTER -o365
  182.     
  183.           This option purges all entries made more than <dddd> days ago.
  184.         Note that there is no space between the "o" and the number.  The
  185.         example above will purge all log entries more than 1 year old.
  186.         
  187.     -p<dd/mm/yy>  Purge entries made Prior to <dd/mm/yy>.
  188.     
  189.                              Example:  DLFILTER -p01/01/93
  190.                              
  191.           This option will purge all log entries made prior to the date
  192.         listed.  Note again that there is no space between the "p" and
  193.         the date.
  194.  
  195.         NOTE: If both the -o and -p options are listed, the last one on
  196.               the command line will be used.
  197.         
  198.     -n  No File Scan
  199.     
  200.                              Example:  DLFILTER -o365 -n
  201.                              
  202.            This option allows you to filter the download log based only
  203.         the age of files, skipping the scan for existing files.  It may
  204.         be used with either the -o or -p options.  (It is also legal to
  205.         use it by itself, causing DLFILTER to do nothing at all).
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.   Whereto from here?
  213.   
  214.           I welcome your comments and suggestions regarding this program
  215.     (and its documentation).  future enhancements may include report
  216.     generation, having the program auto-restart in slow mode if memory
  217.     runs out, and/or the use of XMS for swapping.  I am also working on 
  218.     speeding up the "slow" mode significantly.
  219.         I also welcome your suggestions for other 'nifty little
  220.     utilities' that you would like to see.
  221.  
  222.   Acknowledgements:
  223.   
  224.     This program was written in C++ and compiled using Borland C++ 2.0.
  225.  
  226.     PCBoard is a registered trademark of Clark Development Company, Inc.
  227.     Borland C++ is a trademark of Borland International. 
  228.  
  229.   The Author:
  230.   
  231.       I can be contacted at the following address:
  232.       
  233.       Jon E. Estes
  234.       65 Davis Rd.
  235.       Chicopee, Ma, 01022
  236.       
  237.       I also monitor the SmartNet(tm) C and Chat conferences.  If you
  238.       choose to contact me this way, please address your message to
  239.       Jon Estes.  I can also be reached via the BBS below.
  240.       
  241.    BBS Plug:
  242.    
  243.       Download Filter is distributed through:
  244.       
  245.       Uncle Hanks BBS  - Home of Uncle Hanks Shareware Reviews
  246.       (413) 527-8977  24hrs, 2400-16800 USR DS, PCBoard 14.5a/10.
  247.  
  248.       
  249.